Skip to main content
POST
/
public
/
v1
/
campaign-service
/
campaigns
/
exclusive-listing
[BETA] Create exclusive listing campaign.
curl --request POST \
  --url https://api.topsort.com/public/v1/campaign-service/campaigns/exclusive-listing \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "Bola-Bola Ad campaign",
  "isActive": true,
  "externalCampaignId": "<string>",
  "isAutoTrigger": false,
  "startDate": "2023-11-07T05:31:56Z",
  "endDate": "2023-11-07T05:31:56Z",
  "exclusivityPrice": 123,
  "position": 1,
  "bids": [
    {
      "target": {
        "id": "p_8983",
        "type": "product"
      },
      "triggers": [
        {
          "type": "<string>",
          "value": {
            "categoryId": "<string>"
          }
        }
      ]
    }
  ],
  "walletId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}'
{
  "name": "Bola-Bola Ad campaign",
  "isActive": true,
  "externalCampaignId": "<string>",
  "isAutoTrigger": false,
  "marketplaceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "campaignId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "startDate": "2023-11-07T05:31:56Z",
  "endDate": "2023-11-07T05:31:56Z",
  "exclusivityPrice": 123,
  "bidType": "exclusive",
  "createdBy": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "chargeType": "DAILY",
  "position": 1,
  "walletId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "adFormat": "exclusive_listing",
  "vendorId": "<string>",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z"
}

Authorizations

Authorization
string
header
required

Query Parameters

vendor_id
string
required
Minimum length: 1

Body

application/json
name
string
required
Minimum length: 1
Examples:
startDate
string<date-time>
required
endDate
string<date-time>
required
exclusivityPrice
integer
required
bids
CreateExclusiveListingBid · object[]
required
Minimum length: 1
isActive
boolean
default:true
externalCampaignId
string | null
isAutoTrigger
boolean
default:false
position
integer
default:1
Required range: 1 <= x <= 20
walletId
string<uuid> | null

Response

name
string
required
Minimum length: 1
Examples:
marketplaceId
string<uuid>
required
campaignId
string<uuid>
required
exclusivityPrice
integer
required
chargeType
enum<string>
required
Available options:
DAILY
adFormat
string
required
Allowed value: "exclusive_listing"
Examples:
vendorId
string
required
createdAt
string<date-time>
required
updatedAt
string<date-time>
required
isActive
boolean
default:true
externalCampaignId
string | null
isAutoTrigger
boolean
default:false
startDate
string<date-time>
endDate
string<date-time>
bidType
string
default:exclusive
Allowed value: "exclusive"
createdBy
string<uuid> | null
position
integer
default:1
Required range: 1 <= x <= 20
walletId
string<uuid> | null